Api.RestartSlave method

Restarts the specified slave.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus RestartSlave(
       int SlaveId
)

Public Function RestartSlave(
       SlaveId As Integer
) As KsCommandStatus

Parameters

SlaveId

Type: int

The index of a slave array. When EtherCAT is started, this index has the same value as the SlaveId, which corresponds to the position of the slave in the network. Please note that after EtherCAT is started in the Operational (Op) state, any addition or removal of slaves from the network will change the position of the slaves in the network (SlaveId). Nevertheless, the index of the slave will remain the same. Newly added devices will be added in the back of the slave array. For all slaves after the change, the index and SlaveId will no longer match. This behavior is only available for physical devices; simulated devices are inapplicable. Please refer to the use cases in EnableHotConnect for more details.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

If auto-repair is disabled, use this method to restart a slave after a cable is disconnected or if it has an EtherCAT error. Access to a slave will be blocked during restart, but it won't affect the applications as the slave will return to the normal state. Typically, this method is called when the slave is in the error state and its data is already unavailable.

Usable EtherCAT states

ecatOP

Examples

N/A